<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-config</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME Library Reference Manual">
<link rel="up" href="ch06.html" title="Deprecated Modules">
<link rel="prev" href="ch06.html" title="Deprecated Modules">
<link rel="next" href="libgnome-gnome-i18n.html" title="gnome-i18n">
<meta name="generator" content="GTK-Doc V1.16 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch06.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Library Reference Manual</th>
<td><a accesskey="n" href="libgnome-gnome-i18n.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgnome-gnome-config.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgnome-gnome-config.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgnome-gnome-config"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgnome-gnome-config.top_of_page"></a>gnome-config</span></h2>
<p>gnome-config — Access to configuration files.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgnome-gnome-config.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgnome/libgnome.h&gt;

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-string" title="gnome_config_get_string()">gnome_config_get_string</a>             (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-string-with-default" title="gnome_config_get_string_with_default()">gnome_config_get_string_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-translated-string" title="gnome_config_get_translated_string()">gnome_config_get_translated_string</a>  (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-translated-string-with-default" title="gnome_config_get_translated_string_with_default()">gnome_config_get_translated_string_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-string" title="gnome_config_private_get_string()">gnome_config_private_get_string</a>     (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-string-with-default" title="gnome_config_private_get_string_with_default()">gnome_config_private_get_string_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-translated-string" title="gnome_config_private_get_translated_string()">gnome_config_private_get_translated_string</a>(path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-translated-string-with-default" title="gnome_config_private_get_translated_string_with_default()">gnome_config_private_get_translated_string_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-string" title="gnome_config_set_string()">gnome_config_set_string</a>             (path,
                                                         new_value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-translated-string" title="gnome_config_set_translated_string()">gnome_config_set_translated_string</a>  (path,
                                                         value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-string" title="gnome_config_private_set_string()">gnome_config_private_set_string</a>     (path,
                                                         new_value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-translated-string" title="gnome_config_private_set_translated_string()">gnome_config_private_set_translated_string</a>(path,
                                                         new_value)

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-int" title="gnome_config_get_int()">gnome_config_get_int</a>                (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-int-with-default" title="gnome_config_get_int_with_default()">gnome_config_get_int_with_default</a>   (path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-int" title="gnome_config_private_get_int()">gnome_config_private_get_int</a>        (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-int-with-default" title="gnome_config_private_get_int_with_default()">gnome_config_private_get_int_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-int" title="gnome_config_set_int()">gnome_config_set_int</a>                (path,
                                                         new_value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-int" title="gnome_config_private_set_int()">gnome_config_private_set_int</a>        (path,
                                                         new_value)

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-float" title="gnome_config_get_float()">gnome_config_get_float</a>              (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-float-with-default" title="gnome_config_get_float_with_default()">gnome_config_get_float_with_default</a> (path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-float" title="gnome_config_private_get_float()">gnome_config_private_get_float</a>      (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-float-with-default" title="gnome_config_private_get_float_with_default()">gnome_config_private_get_float_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-float" title="gnome_config_set_float()">gnome_config_set_float</a>              (path,
                                                         new_value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-float" title="gnome_config_private_set_float()">gnome_config_private_set_float</a>      (path,
                                                         new_value)

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-bool" title="gnome_config_get_bool()">gnome_config_get_bool</a>               (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-bool-with-default" title="gnome_config_get_bool_with_default()">gnome_config_get_bool_with_default</a>  (path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-bool" title="gnome_config_private_get_bool()">gnome_config_private_get_bool</a>       (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-bool-with-default" title="gnome_config_private_get_bool_with_default()">gnome_config_private_get_bool_with_default</a>(path,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-bool" title="gnome_config_set_bool()">gnome_config_set_bool</a>               (path,
                                                         new_value)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-bool" title="gnome_config_private_set_bool()">gnome_config_private_set_bool</a>       (path,
                                                         new_value)

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-vector" title="gnome_config_get_vector()">gnome_config_get_vector</a>             (path,
                                                         argcp,
                                                         argvp)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-vector-with-default" title="gnome_config_get_vector_with_default()">gnome_config_get_vector_with_default</a>(path,
                                                         argcp,
                                                         argvp,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-vector" title="gnome_config_private_get_vector()">gnome_config_private_get_vector</a>     (path,
                                                         argcp,
                                                         argvp)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-vector-with-default" title="gnome_config_private_get_vector_with_default()">gnome_config_private_get_vector_with_default</a>(path,
                                                         argcp,
                                                         argvp,
                                                         def)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-set-vector" title="gnome_config_set_vector()">gnome_config_set_vector</a>             (path,
                                                         argc,
                                                         argv)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-set-vector" title="gnome_config_private_set_vector()">gnome_config_private_set_vector</a>     (path,
                                                         argc,
                                                         argv)
<span class="returnvalue">char</span> *              <a class="link" href="libgnome-gnome-config.html#gnome-config-assemble-vector" title="gnome_config_assemble_vector ()">gnome_config_assemble_vector</a>        (<em class="parameter"><code><span class="type">int</span> argc</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *const argv[]</code></em>);

#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-has-section" title="gnome_config_has_section()">gnome_config_has_section</a>            (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-has-section" title="gnome_config_private_has_section()">gnome_config_private_has_section</a>    (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-init-iterator" title="gnome_config_init_iterator()">gnome_config_init_iterator</a>          (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-init-iterator" title="gnome_config_private_init_iterator()">gnome_config_private_init_iterator</a>  (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-init-iterator-sections" title="gnome_config_init_iterator_sections()">gnome_config_init_iterator_sections</a> (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-init-iterator-sections" title="gnome_config_private_init_iterator_sections()">gnome_config_private_init_iterator_sections</a>(path)
<span class="returnvalue">void</span> *              <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()">gnome_config_iterator_next</a>          (<em class="parameter"><code><span class="type">void</span> *iterator_handle</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **key</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **value</code></em>);

<span class="returnvalue">void</span>                <a class="link" href="libgnome-gnome-config.html#gnome-config-drop-all" title="gnome_config_drop_all ()">gnome_config_drop_all</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()">gnome_config_sync</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-sync-file" title="gnome_config_sync_file()">gnome_config_sync_file</a>              (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-sync-file" title="gnome_config_private_sync_file()">gnome_config_private_sync_file</a>      (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-drop-file" title="gnome_config_drop_file()">gnome_config_drop_file</a>              (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-drop-file" title="gnome_config_private_drop_file()">gnome_config_private_drop_file</a>      (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-clean-file" title="gnome_config_clean_file()">gnome_config_clean_file</a>             (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-clean-file" title="gnome_config_private_clean_file()">gnome_config_private_clean_file</a>     (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-clean-section" title="gnome_config_clean_section()">gnome_config_clean_section</a>          (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-clean-section" title="gnome_config_private_clean_section()">gnome_config_private_clean_section</a>  (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-clean-key" title="gnome_config_clean_key()">gnome_config_clean_key</a>              (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-clean-key" title="gnome_config_private_clean_key()">gnome_config_private_clean_key</a>      (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-get-real-path" title="gnome_config_get_real_path()">gnome_config_get_real_path</a>          (path)
#define             <a class="link" href="libgnome-gnome-config.html#gnome-config-private-get-real-path" title="gnome_config_private_get_real_path()">gnome_config_private_get_real_path</a>  (path)
<span class="returnvalue">void</span>                <a class="link" href="libgnome-gnome-config.html#gnome-config-push-prefix" title="gnome_config_push_prefix ()">gnome_config_push_prefix</a>            (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgnome-gnome-config.html#gnome-config-pop-prefix" title="gnome_config_pop_prefix ()">gnome_config_pop_prefix</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libgnome-gnome-config.html#gnome-config-make-vector" title="gnome_config_make_vector ()">gnome_config_make_vector</a>            (<em class="parameter"><code>const <span class="type">char</span> *string</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> *argcp</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> ***argvp</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgnome-gnome-config.description"></a><h2>Description</h2>
<p>
This module provides a simple method of retrieving and storing configuration
data that resides in files. It also provides the ability to supply default
values for the configuration parameters to simply client code.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
	The purpose of this module is different in GNOME 2 from what it was in
	GNOME 1. General applications should use the <span class="type">gnome-gconf</span> module for
	their configuration requirements.
	</p>
<p>
	The gnome-config module exists for applications that
		</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p>need to provide a backwards-compatible
				version of their configuration files, or</p></li>
<li class="listitem"><p>need to run independently of a user and
				access configuration files at absolute
				locations (for example, a login manager), or
				</p></li>
<li class="listitem"><p>need to parse
				<em class="wordasword">.desktop</em>-style files,
				or</p></li>
<li class="listitem"><p>need to parse user- or
				shell-editable/readable files.</p></li>
</ul></div>
<p>
	</p>
</div>
<p><b>Definitions. </b>
    </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><span class="emphasis"><em>config path:</em></span> a string that
        specifies which item to retrieve from the configuration
        database.  The config path is composed of three elements: the
        first one is the filename where the information is stored, the
        second component is the section and the third one is the key
        inside the section</p>
<p>For example, a config path of "/myapp/toolbox/showit"
        could be used to retrieve the setting for whether 'myapp'
        should display its toolbox or not.  In this example "myapp" is
        the file name (which is stored in
        <code class="filename">~/.gnome2</code> directory), "toolbox" is the
        section and "showit" is the key.</p>
<p>If you want to access an absolute file instead of a
        <code class="filename">~/.gnome2</code>-relative file, then you need to
        surround the filename with equal signs, for example, to access
        the key "mykey" from the section "mysection" in a
        configuration file located in
        <code class="filename">/gnome/var/myconfig</code> you need to use this
        path: "=/gnome/var/myconfig=/mysection/mykey".</p>
</li>
<li class="listitem"><p><span class="emphasis"><em>default:</em></span> when retrieving a
        config item, specifies the value to be used if the item is not
        found.</p></li>
<li class="listitem"><p><span class="emphasis"><em>private configuration data:</em></span>
        Normally, config item data is located in files under the
	<code class="filename">~user/.gnome2</code> directory in a .ini-like format.
	These files are world-readable. Items that have security or privacy
	implications are stored and retrieved using the "private" versions of
	the gnome-config routines, and the data for these items is stored in
	files under the <code class="filename">~user/.gnome2_private</code> directory,
	which is not accessable by anyone except that user and the system
	administrator.</p></li>
<li class="listitem"><p><span class="emphasis"><em>translated strings:</em></span> GNOME's
      multilingual support means that multiple languages must be supported for
      configuration items.  The gnome_config_*get_translated_string() and
      gnome_config_*set_translated_string() routines allow you to specify which
      language a string item should be accessed for.
       	</p></li>
<li class="listitem"><p><span class="emphasis"><em>section:</em></span> a group of config items and
      other config sections</p></li>
</ul></div>
<p>
   </p>
<p><b>How Config Items are Read. </b>
    The gnome-config module has a versatile method of storing config items.
    When a config item is written by a program, it is written to a file under
    the <code class="filename">~/.gnome2</code> hierarchy.  However, when config items
    are read, the process is a little more complicated.  There are a number of
    places that are searched.  If the config item is not found in one, then the
    next place is checked, finally falling back to the default value provided
    by the application.  The locations are as follows:
    </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p><code class="filename">$(sysconfdir)/gnome/config-override</code>
        - a system administrator would put config items in this directory
        that they don't want to be configurable.</p></li>
<li class="listitem"><p><code class="filename">~/.gnome</code> - this is where the
        user's config items are written to and is the next place that is
        searched</p></li>
<li class="listitem"><p><code class="filename">$(sysconfdir)/gnome/config</code>
        - this directory would hold system wide default configuration values.
        </p></li>
</ul></div>
<p>
  </p>
<p>
    Possible uses for this are setting system wide defaults such as
    proxy servers for the system (either using
    <code class="filename">config-override</code> to enforce such a policy or
    the <code class="filename">config</code> directory to suggest such a
    default).  It is also possible to configure the application
    through its graphical interface, and then copy the configuration
    file accross to the appropriate system-wide directory.
    The <code class="filename">config-override</code> directory should be used
    sparingly, as it could annoy or confuse some users.  Note also
    that some applications will not read the config items every time
    they are needed, so putting defaults into the
    <code class="filename">config-override</code> directory will not always
    completely enforce a setting.
</p>
<p>
Every function in this module comes in at least two forms. There is the
<code class="function"><code class="function">gnome_config_get_foo()</code></code> version which retrieves the
configuration data from the <code class="filename">~/.gnome2</code> directory (unless an
absolute configuration key is given, as defined above). Then there is the
<code class="function"><code class="function">gnome_config_private_get_foo()</code></code> version, which retrieves
the information from the user's <code class="filename">~/.gnome2-private</code>
directory.
</p>
<p>
For functions dealing with strings, there is a third form of each function
which returns the translated version of the string for the current locale.
</p>
</div>
<div class="refsect1">
<a name="libgnome-gnome-config.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gnome-config-get-string"></a><h3>gnome_config_get_string()</h3>
<pre class="programlisting">#define             gnome_config_get_string(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string. This value should
be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item as a string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-string-with-default"></a><h3>gnome_config_get_string_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_string_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_string_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string. This value should
be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item as a string, or <em class="parameter"><code>def</code></em> if the
configuration key does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-translated-string"></a><h3>gnome_config_get_translated_string()</h3>
<pre class="programlisting">#define             gnome_config_get_translated_string(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_translated_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string appropriate for the
current language. The returned value should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no
longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-translated-string-with-default"></a><h3>gnome_config_get_translated_string_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_translated_string_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_translated_string_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string appropriate for the
current language. The returned value should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no
longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item or <em class="parameter"><code>def</code></em> if the configuration
item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-string"></a><h3>gnome_config_private_get_string()</h3>
<pre class="programlisting">#define             gnome_config_private_get_string(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item from the user's private
configuration directory as a string. This value should be freed with
<a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item as a string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-string-with-default"></a><h3>gnome_config_private_get_string_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_string_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_string_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item from the user's private
configuration directory as a string. This value should be freed with
<a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item as a string, or <em class="parameter"><code>def</code></em> if the
configuration key does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-translated-string"></a><h3>gnome_config_private_get_translated_string()</h3>
<pre class="programlisting">#define             gnome_config_private_get_translated_string(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_translated_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string appropriate for the
current language. The returned value should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no
longer needed.  The item is retrieved from the user's private configuration
storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-translated-string-with-default"></a><h3>gnome_config_private_get_translated_string_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_translated_string_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_translated_string_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string appropriate for the
current language. The returned value should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no
longer needed.  The item is retrieved from the user's private configuration
storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the configuration item or <em class="parameter"><code>def</code></em> if the configuration
item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-string"></a><h3>gnome_config_set_string()</h3>
<pre class="programlisting">#define             gnome_config_set_string(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the string value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A string value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-translated-string"></a><h3>gnome_config_set_translated_string()</h3>
<pre class="programlisting">#define             gnome_config_set_translated_string(path,value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_translated_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the string value <em class="parameter"><code>value</code></em> in the file/section/key defined
by the <em class="parameter"><code>path</code></em> on the proper section for the current language set by
by the user.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>A string value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-string"></a><h3>gnome_config_private_set_string()</h3>
<pre class="programlisting">#define             gnome_config_private_set_string(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the string value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>. The configuration value is stored in the user's
private storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A string value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-translated-string"></a><h3>gnome_config_private_set_translated_string()</h3>
<pre class="programlisting">#define             gnome_config_private_set_translated_string(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_translated_string</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the string value <em class="parameter"><code>new_value</code></em> in the file/section/key defined by the
<em class="parameter"><code>path</code></em> on the proper section for the current language set by by the user.
The configuration value is stored in the user's private storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A string value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-int"></a><h3>gnome_config_get_int()</h3>
<pre class="programlisting">#define             gnome_config_get_int(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_int</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves an integer value configuration item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-int-with-default"></a><h3>gnome_config_get_int_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_int_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_int_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves an integer value configuration item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as an integer or <em class="parameter"><code>def</code></em> if the
configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-int"></a><h3>gnome_config_private_get_int()</h3>
<pre class="programlisting">#define             gnome_config_private_get_int(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_int</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a configuration item as an int from the user's private
configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as an integer.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-int-with-default"></a><h3>gnome_config_private_get_int_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_int_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_int_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a configuration item as an int from the user's private
configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as an integer or <em class="parameter"><code>def</code></em> if the
configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-int"></a><h3>gnome_config_set_int()</h3>
<pre class="programlisting">#define             gnome_config_set_int(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_int</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the integer value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A int value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-int"></a><h3>gnome_config_private_set_int()</h3>
<pre class="programlisting">#define             gnome_config_private_set_int(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_int</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the integer value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>. The value is stored in the user's private
configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A int value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-float"></a><h3>gnome_config_get_float()</h3>
<pre class="programlisting">#define             gnome_config_get_float(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_float</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a floating-point valued configuration item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-float-with-default"></a><h3>gnome_config_get_float_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_float_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_float_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a floating-point valued configuration item.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as a floating-point
number or <em class="parameter"><code>def</code></em> if the configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-float"></a><h3>gnome_config_private_get_float()</h3>
<pre class="programlisting">#define             gnome_config_private_get_float(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_float</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a configuration item from the user's private configuration storage
area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as a floating-point
number.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-float-with-default"></a><h3>gnome_config_private_get_float_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_float_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_float_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a configuration item from the user's private configuration storage
area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as a floating-point
number or <em class="parameter"><code>def</code></em> if the configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-float"></a><h3>gnome_config_set_float()</h3>
<pre class="programlisting">#define             gnome_config_set_float(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_float</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the double value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A double value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-float"></a><h3>gnome_config_private_set_float()</h3>
<pre class="programlisting">#define             gnome_config_private_set_float(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_float</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores the double value <em class="parameter"><code>new_value</code></em> in the file/section/key
defined by the <em class="parameter"><code>path</code></em>. The value is stored in the user's private
configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A double value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-bool"></a><h3>gnome_config_get_bool()</h3>
<pre class="programlisting">#define             gnome_config_get_bool(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_bool</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a boolean configuration value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-bool-with-default"></a><h3>gnome_config_get_bool_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_bool_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_bool_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves a boolean configuration value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item, or <em class="parameter"><code>def</code></em> if the
configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-bool"></a><h3>gnome_config_private_get_bool()</h3>
<pre class="programlisting">#define             gnome_config_private_get_bool(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_bool</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the item from the user's private configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as a boolean.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-bool-with-default"></a><h3>gnome_config_private_get_bool_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_bool_with_default(path,def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_bool_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the item from the user's private configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of a configuration item as a boolean, or <em class="parameter"><code>def</code></em> if the
configuration item does not exist.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-bool"></a><h3>gnome_config_set_bool()</h3>
<pre class="programlisting">#define             gnome_config_set_bool(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_bool</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores boolean value <em class="parameter"><code>new_value</code></em> in the file/section/key defined by
<em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A boolean value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-bool"></a><h3>gnome_config_private_set_bool()</h3>
<pre class="programlisting">#define             gnome_config_private_set_bool(path,new_value)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_bool</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores boolean value <em class="parameter"><code>new_value</code></em> in the file/section/key defined by <em class="parameter"><code>path</code></em>.
The value is stored in the user's private configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_value</code></em> :</span></p></td>
<td>A boolean value to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-vector"></a><h3>gnome_config_get_vector()</h3>
<pre class="programlisting">#define             gnome_config_get_vector(path, argcp, argvp)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string array.
The returned vector should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
<td>Number of elements in the vector.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argvp</code></em> :</span></p></td>
<td>Vector of strings.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-vector-with-default"></a><h3>gnome_config_get_vector_with_default()</h3>
<pre class="programlisting">#define             gnome_config_get_vector_with_default(path, argcp, argvp, def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_vector_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string array.
The returned vector should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
<td>Number of elements in the vector.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argvp</code></em> :</span></p></td>
<td>Vector of strings.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-vector"></a><h3>gnome_config_private_get_vector()</h3>
<pre class="programlisting">#define             gnome_config_private_get_vector(path, argcp, argvp)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string array.
The returned vector should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. The
configuration value is retrieved from the user's private configuration
storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
<td>Number of elements in the vector.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argvp</code></em> :</span></p></td>
<td>Vector of strings.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-vector-with-default"></a><h3>gnome_config_private_get_vector_with_default()</h3>
<pre class="programlisting">#define             gnome_config_private_get_vector_with_default(path, argcp, argvp, def)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_vector_with_default</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the value of a configuration item as a string array.
The returned vector should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. The
configuration value is retrieved from the user's private configuration
storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to an item in the user-private namespace.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
<td>Number of elements in the vector</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argvp</code></em> :</span></p></td>
<td>Vector of strings</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>def</code></em> :</span></p></td>
<td>A pointer to a flag that will be set if the default value for the item
is returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-set-vector"></a><h3>gnome_config_set_vector()</h3>
<pre class="programlisting">#define             gnome_config_set_vector(path,argc,argv)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_set_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores vector <em class="parameter"><code>argv</code></em> in the file/section/key defined by
<em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>The number of elements in <em class="parameter"><code>argv</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>A string array holding the data to store.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-set-vector"></a><h3>gnome_config_private_set_vector()</h3>
<pre class="programlisting">#define             gnome_config_private_set_vector(path,argc,argv)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_set_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Stores vector <em class="parameter"><code>argv</code></em> in the file/section/key defined by <em class="parameter"><code>path</code></em>. The
configuration value is set in the user's private storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>The number of elements in <em class="parameter"><code>argv</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>A string array holding the data to store.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-assemble-vector"></a><h3>gnome_config_assemble_vector ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *              gnome_config_assemble_vector        (<em class="parameter"><code><span class="type">int</span> argc</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *const argv[]</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_assemble_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
This routine returns the the strings in the array contactenated by
spaces. The return value should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when it is no longer
required.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
<td>Number of elements in the <em class="parameter"><code>argv</code></em> string array.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argv</code></em> :</span></p></td>
<td>An array of strings.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string with the concatenation results.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-has-section"></a><h3>gnome_config_has_section()</h3>
<pre class="programlisting">#define             gnome_config_has_section(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_has_section</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Queries the gnome configuration file for the presence
of the section specified in <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a section</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the section exists, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-has-section"></a><h3>gnome_config_private_has_section()</h3>
<pre class="programlisting">#define             gnome_config_private_has_section(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_has_section</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Queries the private gnome configuration file for the presence
of the section specified in <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a section</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the section exists, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-init-iterator"></a><h3>gnome_config_init_iterator()</h3>
<pre class="programlisting">#define             gnome_config_init_iterator(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_init_iterator</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates an iterator handle that can be used to
iterate over the keys in a section in a gnome configuration
file.  <em class="parameter"><code>path</code></em> must refer to a section.  The returned value
can be used as an iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path for a section.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The iterator handle.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-init-iterator"></a><h3>gnome_config_private_init_iterator()</h3>
<pre class="programlisting">#define             gnome_config_private_init_iterator(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_init_iterator</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates an iterator handle that can be used to
iterate over the keys in a section in a private gnome configuration
file.  <em class="parameter"><code>path</code></em> must refer to a section.  The returned value
can be used as an iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path for a section.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The iterator handle.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-init-iterator-sections"></a><h3>gnome_config_init_iterator_sections()</h3>
<pre class="programlisting">#define             gnome_config_init_iterator_sections(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_init_iterator_sections</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates an iterator handle that can be used to iterate over the
sections in a gnome configuration file.  <em class="parameter"><code>path</code></em> must refer to a
gnome configuration file.  The returned value can be used as an
iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path for a file.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The iterator handle.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-init-iterator-sections"></a><h3>gnome_config_private_init_iterator_sections()</h3>
<pre class="programlisting">#define             gnome_config_private_init_iterator_sections(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_init_iterator_sections</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates an iterator handle that can be used to iterate over the
sections in a private gnome configuration file.  <em class="parameter"><code>path</code></em> must refer to a
gnome configuration file.  The returned value can be used as an
iterator for <a class="link" href="libgnome-gnome-config.html#gnome-config-iterator-next" title="gnome_config_iterator_next ()"><code class="function">gnome_config_iterator_next()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path for a file</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The iterator handle.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-iterator-next"></a><h3>gnome_config_iterator_next ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> *              gnome_config_iterator_next          (<em class="parameter"><code><span class="type">void</span> *iterator_handle</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **key</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> **value</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_iterator_next</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
If <em class="parameter"><code>key</code></em> is non-NULL, then <em class="parameter"><code>key</code></em> will point to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-malloc"><code class="function">g_malloc()</code></a>ed region that
holds the key.
</p>
<p>
If <em class="parameter"><code>value</code></em> is non-NULL, then <em class="parameter"><code>value</code></em> will point to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-malloc"><code class="function">g_malloc()</code></a>ed region that
holds the key.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>iterator_handle</code></em> :</span></p></td>
<td>A gnome configu iterator handle, returned from any
iteration start routine or this routine.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>Address where the key gets stored.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>Address where the value gets stored.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-drop-all"></a><h3>gnome_config_drop_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_config_drop_all               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_drop_all</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Drops any information cached in memory that was fetched with
gnome config. Any pending information that has not been
written to disk is discarded.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-sync"></a><h3>gnome_config_sync ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gnome_config_sync                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_sync</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Writes all of the information modified by gnome-config to the
disk.
</p>
<p>
Note: the gnome-config code does not write anything to the
configuration files until this routine is actually invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if everything went well. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if any file
could not be written to disk.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-sync-file"></a><h3>gnome_config_sync_file()</h3>
<pre class="programlisting">#define             gnome_config_sync_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_sync_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Writes all of the information modified by gnome-config to the
disk for the given file.
</p>
<p>
Note: the gnome-config code does not write anything to the
configuration files until this routine or <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a>
is actually invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if everything went well, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the file
could not be written to for some reason.  <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is only returned
when a write was actually attempted and failed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-sync-file"></a><h3>gnome_config_private_sync_file()</h3>
<pre class="programlisting">#define             gnome_config_private_sync_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_sync_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Writes all of the information modified by gnome-config to the
disk for the given private file.
</p>
<p>
Note: the gnome-config code does not write anything to the
configuration files until this routine or <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a>
is actually invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if everything went well, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the file
could not be written to for some reason.  <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is only returned
when a write was actually attempted and failed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-drop-file"></a><h3>gnome_config_drop_file()</h3>
<pre class="programlisting">#define             gnome_config_drop_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_drop_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Releases any memory resources that were allocated from accessing
the configuration file in <em class="parameter"><code>path</code></em>.  Changes will take place after
<a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-drop-file"></a><h3>gnome_config_private_drop_file()</h3>
<pre class="programlisting">#define             gnome_config_private_drop_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_drop_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Releases any memory resources that were allocated from accessing the
private configuration file in <em class="parameter"><code>path</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-clean-file"></a><h3>gnome_config_clean_file()</h3>
<pre class="programlisting">#define             gnome_config_clean_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_clean_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Cleans up the configuration file specified by <em class="parameter"><code>path</code></em> from any
configuration information.
</p>
<p>
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-clean-file"></a><h3>gnome_config_private_clean_file()</h3>
<pre class="programlisting">#define             gnome_config_private_clean_file(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_clean_file</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Cleans up the private configuration file specified by <em class="parameter"><code>path</code></em> from
any configuration information.
</p>
<p>
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome-config path</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-clean-section"></a><h3>gnome_config_clean_section()</h3>
<pre class="programlisting">#define             gnome_config_clean_section(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_clean_section</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Cleans up the section specified by <em class="parameter"><code>path</code></em> from any
configuration information.  Changes will only take place
after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a section.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-clean-section"></a><h3>gnome_config_private_clean_section()</h3>
<pre class="programlisting">#define             gnome_config_private_clean_section(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_clean_section</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Cleans up the section specified by <em class="parameter"><code>path</code></em> in a private file from any
configuration information.  Changes will only take place after
<a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a section.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-clean-key"></a><h3>gnome_config_clean_key()</h3>
<pre class="programlisting">#define             gnome_config_clean_key(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_clean_key</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Removes the definition for the key on a gnome configuration file.
</p>
<p>
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-clean-key"></a><h3>gnome_config_private_clean_key()</h3>
<pre class="programlisting">#define             gnome_config_private_clean_key(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_clean_key</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Removes the definition for the key on a private gnome configuration
file.
</p>
<p>
Changes will take place after <a class="link" href="libgnome-gnome-config.html#gnome-config-sync" title="gnome_config_sync ()"><code class="function">gnome_config_sync()</code></a> has been invoked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path to a key.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-get-real-path"></a><h3>gnome_config_get_real_path()</h3>
<pre class="programlisting">#define             gnome_config_get_real_path(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_get_real_path</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the full (absolute) path to a configuration file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A configuration file (this should only be the file, not the section or
key).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An absolute path to the config file.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-private-get-real-path"></a><h3>gnome_config_private_get_real_path()</h3>
<pre class="programlisting">#define             gnome_config_private_get_real_path(path)</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_private_get_real_path</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Retrieves the full (absolute) path to a configuration file in the user's
private configuration storage area.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A configuration file (this should only be the file, not the section or
key).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>An absolute path to the config file.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-push-prefix"></a><h3>gnome_config_push_prefix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_config_push_prefix            (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_push_prefix</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
<em class="parameter"><code>path</code></em> is a prefix that will be prepended automatically to any
non-absolute configuration path in gnome config.
</p>
<p>
This is used to simplify application loading code.
</p>
<p>
Library code will usually have to set the prefix before doing
any gnome-configuration access, since the application might
be using their own prefix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>A gnome configuration path prefix.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-pop-prefix"></a><h3>gnome_config_pop_prefix ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_config_pop_prefix             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_pop_prefix</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Call this routine to remove the current configuration prefix from the stack.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-config-make-vector"></a><h3>gnome_config_make_vector ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_config_make_vector            (<em class="parameter"><code>const <span class="type">char</span> *string</code></em>,
                                                         <em class="parameter"><code><span class="type">int</span> *argcp</code></em>,
                                                         <em class="parameter"><code><span class="type">char</span> ***argvp</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_config_make_vector</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates a new vector from a string as it stored in the config file,
breaks the string on spaces except if the space is escaped with a
backslash.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>The stringified vector to decode into 'argcp' and 'argvp'</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argcp</code></em> :</span></p></td>
<td>Returns the number of elements in <em class="parameter"><code>string</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>argvp</code></em> :</span></p></td>
<td>Returns the array of strings found in <em class="parameter"><code>string</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.16</div>
</body>
</html>